Docs: Document about roles, people and processes #1230
Conversation
tordans
changed the title
|
🍱 You can preview the tagging presets of this pull request here. |
|
In https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types the suggested name for this file is
I think this fits what we are trying to do here so I think we should use this name. |
MAINTENANCE.md
Outdated
|
|
||
| ### PR Reviews and Merges | ||
|
|
||
| - PRs need approval from two people: the author and one more contributors before being merged. |
There was a problem hiding this comment.
| - PRs need approval from two people: the author and one more contributors before being merged. | |
| - PRs need approval from two people: the author and one or more contributors before being merged. |
There was a problem hiding this comment.
There are other ways to amend this. BTW, is "contributor" requiring any experience/presence? Past accepted PR? It is kind of unclear
There was a problem hiding this comment.
BTW, is "contributor" requiring any experience/presence? Past accepted PR? It is kind of unclear
I just added a very high level section to handle the question how the defined roles are assigned https://github.com/openstreetmap/id-tagging-schema/pull/1230/files#diff-87a0c4623bffa64c60b62a39eeab1c40bd0f329cebc177f5e4492555fb5d42aeR68-R73
This does not go into details on which criteria are used to make this decision which is IMO fine because in the absence of published criteria it is clear IMO that the person responsible for the step will have to make a judgement decision.
Ping @tyrasd
Co-authored-by: Mateusz Konieczny <matkoniecz@gmail.com>
|
|
||
| and all the following roles. | ||
|
|
||
| ### Contributor Role |
There was a problem hiding this comment.
Maybe different name may be better? Github is using "contributor" to refer to anyone who got commit accepted and to anyone who opened a PR (within that PR). This document itself uses contributor a bit below in yet another meaning.
Maybe "Helper"?
There was a problem hiding this comment.
Good point. Github also uses "collaborator" …
I think that badge appeared once I had triage roles but I am not sure if the name changed. I remember that the triage role added a name that suggested to readers that I had more of a maintainer role, which is not true.
Unfortunately https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization does not explain which badge is added when.
I think to clarify we should add the github badge name to this section so there is a reference.
We might need to test this out by changing my permission @tyrasd
There was a problem hiding this comment.
I added the names of the github labels as I understand them ATM. We will need to look for better names of the chapters/roles.
There was a problem hiding this comment.
"Collaborator" is when your account is added to project and has any rights assignable on github (at least from my understanding/memory).
"First-time contributor" is on PR of someone who has their first PR in repo (not sure is it overriding other labels)
"Contributor" - their changes were accepted into repo (not sure about edge cases like their PR merged that contained no commits they made or commits authored/committed by them being accepted without opening PR etc)
| (No one has the triage role at the moment. Please reach out if you want to help.) | ||
|
|
||
| The triage role includes: | ||
| - Helping to clarify issues and PRs. |
There was a problem hiding this comment.
Maybe it can be also clarified that people with no formal triage role are encouraged to do this?
There was a problem hiding this comment.
Maybe "Helping to clarify issues and PRs." should be moved altogether to section below?
| - Helping to clarify issues and PRs. | ||
| - Closing issues as duplicates or not planned. | ||
|
|
||
| ### Contributors |
There was a problem hiding this comment.
Note confusion with "Contributor role"
|
Just to clarify: all comments I made here are not statement/request/official communication of any organization. And it is just my regular, hopefully useful, nitpicking/debugging. |
|
|
||
| The contributor role includes: | ||
| - Reviewing PRs. | ||
| - Merging "clear-cut" PRs. |
There was a problem hiding this comment.
Is it OK for them to merge own PRs if they seem clear cut for them?
There was a problem hiding this comment.
Technically they cannot due to branch protection rules. But lets make it explicit. How about…
| - Merging "clear-cut" PRs. | |
| - Merging "clear-cut" PRs by others. |
@tyrasd following our conversation on the last iD community call I created this draft of a separate document that gives more visibility on who is doing what in this repository and how some of the core processes are strucutres.
This is not as fleshed out as #1229, especially the process part. But a good way to improve this will be using it and changing it over time, I think.
In this document I changed my role to the contributor role which I still offer to do.
Parts of this are inspired by https://github.com/streetcomplete/StreetComplete/blob/master/AUTHORS.md – thanks a lot